// <editor-fold defaultstate="collapsed" desc="GNU GPLv3 Header">
/*
 * File:   GenericFormatChunkWaveFile.java
 *
 * Copyright (C) 2013 Robert Antoni Buj Gelonch <rbuj@uoc.edu>
 * Copyright (C) 2013 David Megias Jimenez <dmegias@uoc.edu>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
// </editor-fold>
package readwritewave;

// <editor-fold defaultstate="collapsed" desc="imports">
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
// </editor-fold>

/**
 * Class for reading and writing the format chunk of PCM-LE wave audio files.
 *
 * @author Robert Antoni Buj Gelonch <rbuj@uoc.edu>
 * @version 1.0
 * @since 2013-08-04
 */
class PCMFormatChunkWaveFile extends GenericFormatChunkWaveFile {

    /**
     * The wBitsPerSample field specifies the number of bits of data used to 
     * represent each sample of each channel. If there are multiple channels, 
     * the sample size is the same for each channel.
     */
    short wBitsPerSample;

    /**
     *
     * @author Robert Antoni Buj Gelonch <rbuj@uoc.edu>
     * @version 1.0
     * @since 2013-08-04
     */
    PCMFormatChunkWaveFile(GenericFormatChunkWaveFile generic, DataInputStream dis)
            throws IOException {
        super(generic.lngStart, generic.strID, generic.lngSize,
                generic.wFormatTag, generic.wChannels, generic.dwSamplesPerSec,
                generic.dwAvgBytesPerSec, generic.wBlockAlign);
        wBitsPerSample = readShortLE(dis);
    }

    /**
     *
     * @param dis
     * @return the bits per sample
     * @see short
     *
     * @author Robert Antoni Buj Gelonch <rbuj@uoc.edu>
     * @version 1.0
     * @since 2013-08-04
     */
    public short getWBitsPerSample() {
        return wBitsPerSample;
    }

    /**
     *
     * @param dos
     *
     * @author Robert Antoni Buj Gelonch <rbuj@uoc.edu>
     * @version 1.0
     * @since 2013-08-04
     */
    private void writeWBitsPerSample(DataOutputStream dos) throws IOException {
        writeShortLE(wBitsPerSample, dos);
    }

    /**
     *
     * @param dos
     * 
     * @author Robert Antoni Buj Gelonch <rbuj@uoc.edu>
     * @version 1.0
     * @since 2013-08-04
     */
    void save(DataOutputStream dos) throws IOException {
        writeID(dos);
        writeSize(dos);
        writeWFormatTag(dos);
        writeWChannels(dos);
        writeDWSamplesPerSec(dos);
        writeDWAvgBytesPerSec(dos);
        writeWBlockAlign(dos);
        writeWBitsPerSample(dos);
    }
}
